docs: hint to typescript matcher extensions in image snapshots #8537
+1
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for vitest-dev ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
sheremet-va
requested changes
Oct 3, 2025
| ## Image Snapshots | ||
|
|
||
| It's also possible to snapshot images using [`jest-image-snapshot`](https://github.com/americanexpress/jest-image-snapshot). | ||
| It's also possible to snapshot images using [`jest-image-snapshot`](https://github.com/americanexpress/jest-image-snapshot). When using Typescript, you will need to [extend the `Assertion` interface](/guide/extending-matchers.html). |
There was a problem hiding this comment.
This doesn't really explain anything. If you need to have types for this package, you just need to have @types/jest-image-snapshot installed. This is something that should be explained by the package itself
There was a problem hiding this comment.
jest-image-snapshot users need to use expect.extend, which unfortunately doesn't add typing. However, going over their docs again, there is a section mentioning the necessity to add a matcher. I will close the PR as the package docs (partially) explain how to do it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The Snapshot guide describes usage of the
toMatchImageSnapshotmatcher fromjest-image-snapshot.In Typescript, it is necessary to extend the
Assertiontype declaration, otherwiseexpect().toMatchImageSnapshotisn't typed. This PR adds a reference to the Extending matchers page.Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
pnpm-lock.yamlunless you introduce a new test example.Tests
pnpm test:ci.Documentation
pnpm run docscommand.Changesets
feat:,fix:,perf:,docs:, orchore:.